PR: Cherry-pick common-v8 from upstream by miccy · Pull Request #22 · SQLoot/evolu-plan-b

miccy · 2026-02-04T23:21:58Z

Description

Type of Change

Checklist

Code follows project style guidelines
Tests pass locally (bun run check)
Documentation updated (if applicable)
No secrets or sensitive data included

Related Issues

Summary by CodeRabbit

New Features
- Added a standalone, schema-scoped query builder for creating typed queries without an instance; examples updated to use it.
Breaking Changes
- Instance-based query creation removed — migrate existing code to the new per‑schema builder.
Documentation
- Expanded Test‑Driven Development guidance with detailed Vitest/browser testing examples and workflows.
Chores
- Switched test tooling to Vitest, adjusted test configs/scripts, and bumped several dev/type/package versions.

Introduce a root vitest.config.ts and split package test configs into unit and browser projects (packages/common/vitest.unit.config.ts, packages/common/vitest.browser.config.ts). Remove the old combined common vitest config and migrate per-package coverage/test settings into the central config. Update package.json scripts to run Vitest from the repo root, remove per-package Vitest deps where appropriate, and add browser/playwright-related devDeps at the root. Adjust tsconfigs (add root tsconfig.json and include vitest.*.config.ts in packages/common) and simplify turbo.json task entries. Also add a README link to the Vitest VS Code extension.

Replace the brief Test-driven development note with an expanded TDD section that explains how to run tests, test file locations, and filtering by test name. Add subsections on test structure, type testing (expectTypeOf), and inline snapshot usage with Vitest code examples. Remove the previous Vitest filtering CLI snippets and some commit-message examples to streamline the guidance and surface more actionable testing patterns for contributors.

Rename vitest.config.ts → vitest.config.mts (switch to .mts/ESM), update tsconfig include to reference vitest.config.mts, and add a new "scripts" test project in the Vitest config to include tests matching scripts/**/*.test.mts. Also simplify package.json "verify" script by removing the generic "pnpm test" step.

Introduce a standalone createQueryBuilder(Schema) to build typed Kysely queries without an Evolu instance. The createQuery implementation was moved into packages/common/src/local-first/Schema.ts and exported from index.ts; Evolu.createQuery was removed from the Evolu interface/instance. Updated usages across playgrounds to call createQuery(...) (created via createQueryBuilder) and adjusted types/docs in Query.ts. Added a changeset noting the API migration and guidance to replace evolu.createQuery with createQueryBuilder(Schema).

…mentation and configuration schema.

coderabbitai · 2026-02-04T23:22:08Z

📝 Walkthrough

Walkthrough

Adds a standalone createQueryBuilder API and removes createQuery from Evolu instances; reorganizes Vitest configs into root and per-package projects; updates test scripts and devDependencies; updates examples to use schema-scoped query builders and performs dependency/tooling bumps.

Changes

Cohort / File(s)	Summary
Core API & Types `packages/common/src/local-first/Schema.ts`, `packages/common/src/index.ts`, `packages/common/src/local-first/Evolu.ts`, `packages/common/src/local-first/Query.ts`	Add and export `createQueryBuilder` and related CreateQuery surface in Schema.ts and index; remove `createQuery` from the Evolu instance/public surface and update imports/exports and examples.
Schema Implementation `packages/common/src/local-first/Schema.ts`	Implement `createQueryBuilder`, guard against SQL mutations via `isSqlMutation`, serialize queries, and adjust `ensureDbSchema` local mutation handling.
Examples & Consumers `apps/web/src/app/.../EvoluFullExample.tsx`, `apps/web/src/app/.../EvoluMultitenantExample.tsx`, `examples//src/`, `examples/angular-vite-pwa/src/app/schema.ts`, `examples//components/`	Replace `evolu.createQuery(...)` with schema-scoped `createQuery = createQueryBuilder(Schema)` or `Evolu.createQueryBuilder(Schema)` across examples and update imports/exports where needed.
Testing Configs (Vitest) `vitest.config.mts`, `packages/common/vitest.unit.config.ts`, `packages/common/vitest.browser.config.ts`, `packages/*/vitest.config.ts`, `packages/common/vitest.config.ts` (removed)	Add root `vitest.config.mts`, add per-package project configs, convert configs from `defineConfig`→`defineProject`, add unit/browser split configs and remove the legacy combined `packages/common/vitest.config.ts`.
Scripts & Orchestration `package.json`, `turbo.json`, `tsconfig.json`, `packages/*/package.json`, `packages/common/package.json`, `packages/nodejs/package.json`, `packages/web/package.json`	Move test orchestration to root Vitest, remove per-package test scripts and Turbo test tasks, update `test`/`test:coverage`/`test:watch` scripts, and rework devDependency placements.
Manifests & Tooling Bumps `biome.json`, `.ai/...`, `AGENTS.md`, `examples//package.json`, `packages//package.json`	Bump tooling versions (Biome 2.3.13→2.3.14, turbo, webpack), update `@types/react` and various example package versions, reorganize devDependencies, and add Vitest browser/coverage packages at root.
Tests, Docs & Minor Edits `packages/common/test/local-first/Protocol.test.ts`, `.github/copilot-instructions.md`, `README.md`, `packages/common/src/Error.ts`, `.changeset/create-query-builder.md`, `scripts/typedoc-plugin-evolu.test.mts`	Formatting and snapshot updates in tests; expanded TDD/testing docs; small README/comment edits; add changeset describing the createQueryBuilder public API.
Config Additions/Removals `packages/common/vitest.config.ts` (removed), `packages/common/vitest.unit.config.ts` (added), `vitest.config.mts` (added), `tsconfig.json` (added)	Remove legacy combined config, add focused per-project configs and a root vitest config, and add a tsconfig for vitest config typing.

Sequence Diagram(s)

sequenceDiagram
    participant App as Example App
    participant QBFactory as createQueryBuilder(Schema)
    participant Compiler as Query Compiler
    participant DB as Database

    App->>QBFactory: createQueryBuilder(Schema) [once]
    QBFactory->>QBFactory: return createQuery function

    rect rgba(100, 200, 150, 0.5)
        Note over App,Compiler: Old Pattern (instance-bound)
        App->>App: evolu.createQuery((db) => db.selectFrom(todos))
        App->>Compiler: compile query
        Compiler->>DB: execute
    end

    rect rgba(150, 150, 200, 0.5)
        Note over App,QBFactory: New Pattern (standalone, reusable)
        App->>QBFactory: const todosQuery = createQuery((db) => db.selectFrom(todos))
        QBFactory->>Compiler: compile query
        Compiler->>DB: execute
        App->>QBFactory: const projectsQuery = createQuery((db) => db.selectFrom(projects))
        QBFactory->>Compiler: compile query
        Compiler->>DB: execute
    end

Estimated code review effort

🎯 4 (Complex) | ⏱️ ~60 minutes

Poem

🐰 I built a builder in the glade,
Queries hop free, no instance made,
Tests rearranged and configs pruned,
Versions nudged and docs attuned,
I nibble code and bound with pride.

Note

🎁 Summarized by CodeRabbit Free

Your organization is on the Free plan. CodeRabbit will generate a high-level summary and a walkthrough for each pull request. For a comprehensive line-by-line review, please upgrade your subscription to CodeRabbit Pro by visiting https://app.coderabbit.ai/login.

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

Copilot

Pull request overview

This PR cherry-picks changes from the upstream common-v8 branch, implementing a major refactoring of the testing infrastructure and introducing a breaking API change for query creation.

Changes:

Centralized Vitest configuration at the repository root with workspace support, removing package-level test scripts
Introduced createQueryBuilder as a standalone function, replacing the evolu.createQuery method (breaking change)
Updated dependencies including Biome (2.3.14), Kysely (0.28.11), Turbo (2.8.3), and various React type definitions

Reviewed changes

Copilot reviewed 40 out of 42 changed files in this pull request and generated 4 comments.

Show a summary per file

File	Description
vitest.config.mts	New root-level Vitest workspace configuration
tsconfig.json	New root TypeScript config for vitest.config.mts
turbo.json	Removed test-related tasks (now handled by root vitest)
package.json	Centralized test commands to use vitest directly
packages/common/vitest.*.config.ts	Split vitest config into separate unit and browser configs
packages/common/src/local-first/Schema.ts	Added `createQueryBuilder` function
packages/common/src/local-first/Evolu.ts	Removed `createQuery` method from Evolu interface
packages/common/src/index.ts	Exported `createQueryBuilder`
packages/*/vitest.config.ts	Changed from `defineConfig` to `defineProject`
packages/*/package.json	Removed test scripts, updated dependencies
apps/web playgrounds	Updated to use `createQueryBuilder` (partial)
.changeset/create-query-builder.md	Major version changeset for breaking API change

apps/web/src/app/(playgrounds)/playgrounds/minimal/EvoluMinimalExample.tsx

.changeset/create-query-builder.md

packages/common/src/local-first/Evolu.ts

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Signed-off-by: Miccy <code@miccy.dev>

Copilot · 2026-02-04T23:55:33Z

@miccy I've opened a new pull request, #23, to work on those changes. Once the pull request is ready, I'll request review from you.

Copilot · 2026-02-04T23:55:59Z

@miccy I've opened a new pull request, #24, to work on those changes. Once the pull request is ready, I'll request review from you.

* Initial plan * Revert EvoluMinimalExample.tsx to working state from 13fab62 Co-authored-by: miccy <9729864+miccy@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: miccy <9729864+miccy@users.noreply.github.com>

* Initial plan * Update all examples to use createQueryBuilder instead of evolu.createQuery Co-authored-by: miccy <9729864+miccy@users.noreply.github.com> * Fix CI: add build:docs before typedoc-plugin tests in verify script Co-authored-by: miccy <9729864+miccy@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: miccy <9729864+miccy@users.noreply.github.com>

Signed-off-by: Miccy <support@miccy.dev>

miccy

@copilot Zkontroluj ještě proč neprošlo CI

Copilot · 2026-02-05T06:01:11Z

@miccy I've opened a new pull request, #27, to work on those changes. Once the pull request is ready, I'll request review from you.

…ted callbacks.

…n tests in the verify script.

… local constant for current schema.

steida and others added 11 commits February 4, 2026 13:09

Clarify ESLint 'Unsafe...' troubleshooting

13fab62

Update TreeShaking.test.ts

60ac61b

Use 'observability' term in error comment

dd0b8a6

chore: format

969a82d

update: minors

f6ed047

fix: missing dependencies and verified build

5445ac2

chore: Update Biome to version 2.3.14 and reflect this change in docu…

1fe6836

…mentation and configuration schema.

miccy requested a review from Copilot February 4, 2026 23:21

miccy assigned miccy and Copilot Feb 4, 2026

miccy added upstream Needs cherry-pick or merge from upstream feat New feature or request labels Feb 4, 2026

Copilot started reviewing on behalf of miccy February 4, 2026 23:22 View session

Copilot AI reviewed Feb 4, 2026

View reviewed changes

miccy and others added 2 commits February 5, 2026 00:39

Update packages/common/src/local-first/Evolu.ts

07f0836

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Signed-off-by: Miccy <code@miccy.dev>

Update packages/common/src/local-first/Evolu.ts

f05c64a

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Signed-off-by: Miccy <code@miccy.dev>

Copilot AI mentioned this pull request Feb 4, 2026

Fix CI: generate docs before typedoc-plugin tests #23

Merged

Copilot AI mentioned this pull request Feb 4, 2026

Revert EvoluMinimalExample.tsx to working implementation #24

Merged

Copilot AI and others added 3 commits February 5, 2026 04:52

Merge branch 'main' into merge/common-v8-04-02-2026

923ab54

Signed-off-by: Miccy <support@miccy.dev>

miccy commented Feb 5, 2026

View reviewed changes

Copilot AI mentioned this pull request Feb 5, 2026

Fix CI: Exclude typedoc test from regular test run #27

Merged

Copilot AI and others added 4 commits February 5, 2026 07:52

Fix CI: Exclude typedoc test from regular test run (#27)

dcec9a6

fix: Correct Uint8Array type signature in exportDatabase and rela…

3e8c0db

…ted callbacks.

chore: Update Angular and Svelte dependencies and enable documentatio…

12427a0

…n tests in the verify script.

refactor: improve schema difference calculation for columns and use a…

e78be8c

… local constant for current schema.

miccy merged commit 3cb6e4d into main Feb 5, 2026
5 checks passed

miccy deleted the merge/common-v8-04-02-2026 branch February 10, 2026 01:26

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

PR: Cherry-pick common-v8 from upstream#22

PR: Cherry-pick common-v8 from upstream#22
miccy merged 20 commits intomainfrom
merge/common-v8-04-02-2026

miccy commented Feb 4, 2026 •

edited by coderabbitai bot

Loading

Uh oh!

coderabbitai bot commented Feb 4, 2026 •

edited

Loading

Walkthrough

Changes

Sequence Diagram(s)

Estimated code review effort

Poem

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI commented Feb 4, 2026

Uh oh!

Copilot AI commented Feb 4, 2026

Uh oh!

miccy left a comment

Uh oh!

Copilot AI commented Feb 5, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Conversation

miccy commented Feb 4, 2026 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Type of Change

Checklist

Related Issues

Summary by CodeRabbit

Uh oh!

coderabbitai bot commented Feb 4, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Sequence Diagram(s)

Estimated code review effort

Poem

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI commented Feb 4, 2026

Uh oh!

Copilot AI commented Feb 4, 2026

Uh oh!

miccy left a comment

Choose a reason for hiding this comment

Uh oh!

Copilot AI commented Feb 5, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

miccy commented Feb 4, 2026 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Feb 4, 2026 •

edited

Loading